/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions Copyright [year] [name of copyright owner]".
 *
 * Copyright 2006-2008 Sun Microsystems, Inc.
 * Portions Copyright 2014-2016 ForgeRock AS.
 */
package org.opends.server.core;

import java.util.List;

import org.opends.server.types.*;
import org.forgerock.opendj.ldap.ByteString;
import org.forgerock.opendj.ldap.DN;
import org.forgerock.opendj.ldap.RDN;
import org.opends.server.types.operation.SubordinateModifyDNOperation;

/**
 * This interface defines an operation used to move an entry in
 * the Directory Server.
 */
public interface ModifyDNOperation
       extends Operation, SubordinateModifyDNOperation
{

  /**
   * Retrieves the raw, unprocessed entry DN as included in the client request.
   * The DN that is returned may or may not be a valid DN, since no validation
   * will have been performed upon it.
   *
   * @return  The raw, unprocessed entry DN as included in the client request.
   */
  @Override
  ByteString getRawEntryDN();

  /**
   * Specifies the raw, unprocessed entry DN as included in the client request.
   * This should only be called by pre-parse plugins.
   *
   * @param  rawEntryDN  The raw, unprocessed entry DN as included in the client
   *                     request.
   */
  void setRawEntryDN(ByteString rawEntryDN);


  /**
   * Retrieves the DN of the entry to rename.  This should not be called by
   * pre-parse plugins because the processed DN will not be available yet.
   * Instead, they should call the <CODE>getRawEntryDN</CODE> method.
   *
   * @return  The DN of the entry to rename, or <CODE>null</CODE> if the raw
   *          entry DN has not yet been processed.
   */
  @Override
  DN getEntryDN();

  /**
   * Retrieves the raw, unprocessed newRDN as included in the request from the
   * client.  This may or may not contain a valid RDN, as no validation will
   * have been performed on it.
   *
   * @return  The raw, unprocessed newRDN as included in the request from the
   *          client.
   */
  @Override
  ByteString getRawNewRDN();

  /**
   * Specifies the raw, unprocessed newRDN as included in the request from the
   * client.  This should only be called by pre-parse plugins and should not be
   * used in later stages of processing.
   *
   * @param  rawNewRDN  The raw, unprocessed newRDN as included in the request
   *                    from the client.
   */
  void setRawNewRDN(ByteString rawNewRDN);

  /**
   * Retrieves the new RDN to use for the entry.  This should not be called by
   * pre-parse plugins, because the processed newRDN will not yet be available.
   * Pre-parse plugins should instead use the <CODE>getRawNewRDN</CODE> method.
   *
   * @return  The new RDN to use for the entry, or <CODE>null</CODE> if the raw
   *          newRDN has not yet been processed.
   */
  @Override
  RDN getNewRDN();


  /**
   * Indicates whether the current RDN value should be removed from the entry.
   *
   * @return  <CODE>true</CODE> if the current RDN value should be removed from
   *          the entry, or <CODE>false</CODE> if not.
   */
  @Override
  boolean deleteOldRDN();

  /**
   * Specifies whether the current RDN value should be removed from the entry.
   *
   * @param  deleteOldRDN  Specifies whether the current RDN value should be
   *                       removed from the entry.
   */
  void setDeleteOldRDN(boolean deleteOldRDN);

  /**
   * Retrieves the raw, unprocessed newSuperior from the client request.  This
   * may or may not contain a valid DN, as no validation will have been
   * performed on it.
   *
   * @return  The raw, unprocessed newSuperior from the client request, or
   *          <CODE>null</CODE> if there is none.
   */
  @Override
  ByteString getRawNewSuperior();

  /**
   * Specifies the raw, unprocessed newSuperior for this modify DN operation, as
   * provided in the request from the client.  This method should only be called
   * by pre-parse plugins.
   *
   * @param  rawNewSuperior  The raw, unprocessed newSuperior as provided in the
   *                         request from the client.
   */
  void setRawNewSuperior(ByteString rawNewSuperior);

  /**
   * Retrieves the newSuperior DN for the entry.  This should not be called by
   * pre-parse plugins, because the processed DN will not yet be available at
   * that time.  Instead, they should use the <CODE>getRawNewSuperior</CODE>
   * method.
   *
   * @return  The newSuperior DN for the entry, or <CODE>null</CODE> if there is
   *          no newSuperior DN for this request or if the raw newSuperior has
   *          not yet been processed.
   */
  @Override
  DN getNewSuperior();

  /**
   * Retrieves the new DN for the entry.
   *
   * @return The new DN for the entry, or <CODE>null</CODE> if there is
   *          neither newRDN, nor entryDN for this request.
   */
  DN getNewDN();

  /**
   * Retrieves the set of modifications applied to attributes of the target
   * entry in the course of processing this modify DN operation.  This will
   * include attribute-level changes from the modify DN itself (e.g., removing
   * old RDN values if deleteOldRDN is set, or adding new RDN values that don't
   * already exist), but it may also be used by pre-operation plugins to cause
   * additional changes in the entry.  In this case, those plugins may add
   * modifications to this list (they may not remove existing modifications) if
   * any changes should be processed in addition to the core modify DN
   * processing.  Backends may read this list to identify which attribute-level
   * changes were applied in order to more easily apply updates to attribute
   * indexes.
   *
   * @return  The set of modifications applied to attributes during the course
   *          of the modify DN processing, or <CODE>null</CODE> if that
   *          information is not yet available (e.g., during pre-parse plugins).
   */
  List<Modification> getModifications();

  /**
   * Adds the provided modification to the set of modifications to be applied
   * as part of the update.  This should only be called by pre-operation
   * plugins.
   *
   * @param  modification  The modification to add to the set of modifications
   *                       to apply to the entry.
   */
  void addModification(Modification modification);

  /**
   * Retrieves the current entry, before it is renamed.  This will not be
   * available to pre-parse plugins or during the conflict resolution portion of
   * the synchronization processing.
   *
   * @return  The current entry, or <CODE>null</CODE> if it is not yet
   *           available.
   */
  @Override
  Entry getOriginalEntry();


  /**
   * Retrieves the new entry, as it will appear after it is renamed.  This will
   * not be  available to pre-parse plugins or during the conflict resolution
   * portion of the synchronization processing.
   *
   * @return  The updated entry, or <CODE>null</CODE> if it is not yet
   *           available.
   */
  @Override
  Entry getUpdatedEntry();

  /**
   * Retrieves the proxied authorization DN for this operation if proxied
   * authorization has been requested.
   *
   * @return  The proxied authorization DN for this operation if proxied
   *          authorization has been requested, or {@code null} if proxied
   *          authorization has not been requested.
   */
  @Override
  DN getProxiedAuthorizationDN();


  /**
   * Sets the proxied authorization DN for this operation if proxied
   * authorization has been requested.
   *
   * @param dn  The proxied authorization DN for this operation if proxied
   *            authorization has been requested, or {@code null} if proxied
   *            authorization has not been requested.
   */
  @Override
  void setProxiedAuthorizationDN(DN dn);

}
